feat: Add schema support for array items #3218
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
When a parameter is specified as an array, the
type
anditems
of the parameter are not currently rendered in the schema. E.g.produces
This is not valid OpenAPI 3.0.
What is the new behavior?
type
anditems
are specified in the schema.This conforms to the OpenAPI 3.0 spec as described here for how arrays should be serialized in the url: https://swagger.io/docs/specification/v3_0/serialization/#serialization-and-rfc-6570
Does this PR introduce a breaking change?
This PR would add additional OpenAPI properties an existing spec without any callsite updates. It's possible some existing SDK-generation pipeline based off the specs might be triggered to validate new things, but a spec without
items
fortype: array
is not actually valid, which makes me think the chance of breaking SDK generation is fairly slim.Other information